package cgl.narada.transport.rtp;
/**
 * Software License, Version 1.0
 *
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 *
 *Redistribution and use in source and binary forms, with or without
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For
 * further information contact the Community Grids Lab at
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and
 * wherever such third-party acknowledgments normally appear.
 *
 *4) The name Indiana University or Community Grids Lab or GlobalMMCS,
 * shall not be used to endorse or promote products derived from this software
 * without prior written permission from Indiana University.  For written
 * permission, please contact the Advanced Research and Technology Institute
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called GlobalMMCS,
 * nor may Indiana University or Community Grids Lab or GlobalMMCS appear
 * in their name, without prior written permission of ARTI.
 *
 * Indiana University provides no reassurances that the source code provided
 * does not infringe the patent or any other intellectual property rights of
 * any other entity.  Indiana University disclaims any liability to any
 * recipient for claims brought by any other entity based on infringement of
 * intellectual property rights or otherwise.
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS.
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS",
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION
 *GENERATED USING SOFTWARE.
 */


import java.net.DatagramPacket;
import java.net.DatagramSocket;
import java.net.InetAddress;
import java.net.MulticastSocket;
import java.net.SocketException;
import java.util.StringTokenizer;

import cgl.narada.matching.rtp.RtpEvent;
import cgl.narada.transport.TransportDebugFlags;
import cgl.narada.transport.TransportHandler;

/**
    This receiver receives UDP packages on a port and encapsulates them in an RTPEvent message
    and publish them on the given topics.
    It does not examine the structure of the received package.
    It only forwards the received packages to the given topic.

    @author Ahmet Uyar
    $Revision: 1.4 $
    $Date: 2006/05/05 17:32:18 $
*/

public class RTPReceiver extends Thread implements TransportDebugFlags {

   //   public final static int MAX_PACKET_SIZE = 65507;
   public final static int MAX_PACKET_SIZE = 16000;
   private byte[] buffer;
   private DatagramSocket socket; // this can be either a MulticastSocket or DatagramSocket

   private String moduleName = "RTPReceiver: ";
   private TransportHandler transportHandler;
   private int nodeIdentifier = 0;
   private boolean closed = false;
   private int publicationTopic;
   private boolean controlReceiver = false;
   private String linkID;
   private H261BitSetter h261BitSetter;
   private boolean multicastSocket = false; // if the give socket is a MulticastSocket,
                                            //then set it to true

   public RTPReceiver(String linkID,
                      DatagramSocket socket,
                      int publicationTopic,
                      TransportHandler transportHandler) {

      System.out.println(moduleName + "publication topic ==> " + publicationTopic);
      this.linkID = linkID;
      this.socket = socket;
      this.publicationTopic = publicationTopic;
      this.transportHandler = transportHandler;

      if(publicationTopic%2 == 1)
        this.controlReceiver = true;

      buffer = new byte[MAX_PACKET_SIZE];

      if(!controlReceiver)
         h261BitSetter = new H261BitSetter();

      if(socket instanceof MulticastSocket){
         multicastSocket = true;
      }
   }

   /**
    * set the Node Identifier for this link
    */
   public void setNodeIdentifier(int nodeId) {

      if (nodeIdentifier == 0) {
         nodeIdentifier = nodeId;
         return;
      }

      System.out.println(moduleName + "Error: Setting node identifier again?");
   }

   public void run() {
      DatagramPacket dp = new DatagramPacket(buffer, buffer.length);

      if (RTPReceiverThread_Debug) {
         System.out.println(moduleName + "waiting for Datagram packets on port " + socket.getLocalPort() + "...");
      }

      StringTokenizer token;
      int dataInfo;
      int dataLength;
      int port;
      String address;

      try {
         while ( !closed ) {

            socket.receive(dp);
            byte[] data = dp.getData();
            port = dp.getPort();
            dataLength = dp.getLength();

            // if the received data comes from the machine where this broker runs,
            // then discard that package. Since this data could be sent
            // from the sender of a MulticastRTPLink.
            if(this.multicastSocket && dp.getAddress().equals( InetAddress.getLocalHost() )){
//              System.out.println("sent package received. Ignoring...");
              continue;
            }

            //System.out.print("[ r" + messageTracker+++",l"+ dataLength + "]\n");
//            String hostInfo = dp.getAddress().getHostName();
//            int portInfo = dp.getPort();
//            String sender = "rtp://" + hostInfo + ":" + port;

            // if this is a H.261 package, set the freeze release bit on.
            if(!controlReceiver)
               h261BitSetter.setBit(data, 0, dataLength);

            /** The data received now has to be encapsulated into an event and
                subsequently propagated to the protocol layer via the dataReceived
                method in the transportHandler. */

            // if the topic number is bigger than 500, then this is an audio link
            // this is only for tests.
            RtpEvent rtpEvent = new RtpEvent(nodeIdentifier, publicationTopic, data, 0, dataLength);

            transportHandler.dataReceived(rtpEvent.getBytesWithClientFlag(), linkID);
            dp.setLength(buffer.length);

         }/* end while(true) */
      } catch (SocketException se) {
         if(closed)
            return;
         se.printStackTrace();
      } catch (java.io.IOException ioe) {
         ioe.printStackTrace();
      }/* end try-catch*/
   }/* end (run) */

   public void close(){
      closed = true;
      socket.close();
   }

   /**
    * return the ssrc number of this rtp package.
    */
   private int getSSRC(byte data[]){

      int ssrc = cgl.narada.util.ByteUtilities.getInt(data, 8);
      return ssrc;
   }


}



